home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / Libraries / Sherlock 2.0 / Mac v2.0 docs / Text Docs / Mac read.me .txt < prev    next >
Text File  |  1996-04-07  |  5KB  |  141 lines
  1. Sherlock READ.ME for Macintosh
  2.  
  3.  
  4.  
  5. Macintosh Version 2.0 Beta:  April 8, 1996.
  6.  
  7.  
  8.  
  9. Reward
  10.  
  11. A  reward of $5.12 is cheerfully paid to the first person who reports any bug in any part of 
  12. Sherlock.  Typos are worth $1.28.  Send all comments, including bug reports, to:
  13.  
  14.  
  15.     Edward K. Ream:
  16.  
  17.     166 N. Prospect Ave.
  18.  
  19.     Madison, WI 53705
  20.  
  21.     email: edream@mailbag.com
  22.  
  23.     (608) 231-0766
  24.  
  25.  
  26.  
  27. This is beta software
  28.  
  29. Most of the code has been stable for a long time, but there have been some recent changes, 
  30. especially to SPP.  These changes have not been extensively tested.  And there can always be 
  31. distribution problems.  So please,  if you have any problem whatever with Sherlock, let me know 
  32. immediately.  You’ll be doing us both a favor.
  33.  
  34.  
  35.  
  36. Public domain software
  37.  
  38. All source code in this distribution is in the public domain.  The entire Sherlock system, including 
  39. the SPP, SDEL and SDIF programs, was placed in the public domain on June 15, 1991, by its 
  40. author, Edward K. Ream.  Sherlock may be used for any commercial or non-commercial purpose. 
  41.  
  42.  
  43.  
  44.  
  45. DISCLAIMER OF WARRANTIES
  46.  
  47. Edward K. Ream (Ream) specifically disclaims all warranties, expressed or implied, with respect 
  48. to this computer software, including but not limited to implied warranties of merchantability and 
  49. fitness for a particular purpose.  In no event shall Ream be liable for any loss of profit or any 
  50. commercial damage, including but not limited to special, incidental, consequential or other 
  51. damages.
  52.  
  53. Documentation
  54.  
  55. The following documentation files are in MacWrite Pro format.
  56.  
  57. Text versions of these files have also been provided.  They have a .txt suffix.
  58.  
  59. I recommend reading the documentation in the following order.
  60.  
  61.  
  62. Mac Introduction    A general introduction to Sherlock, including extensions for the Mac.
  63.  
  64. Mac Installation    A guide to installing and initializing Sherlock on a Macintosh.
  65.  
  66. Mac Macros        A tutorial reference to all Sherlock macros.  Includes a 1-page summary.
  67.  
  68. Mac Debugging    How to use Sherlock to find common kinds of bugs.
  69.  
  70.  
  71. The following files describe tools supplied with Sherlock:
  72.  
  73.  
  74. Mac SPP Reference    Reference for SPP.  SPP inserts Sherlock macros into C files.
  75.  
  76. Mac SDEL        Reference for SDEL.  SDEL deletes Sherlock macros from C files.
  77.  
  78. Mac SDIF        Reference for SDIF.  SDIF compares files containing Sherlock macros.
  79.  
  80.  
  81. The following files contain code-level documentation.  The description of Sherlock in Mac DevLib 
  82. includes information not found anywhere else.
  83.  
  84.  
  85. Mac DevLib        Describes DevLib and Sherlock.  See below for more details.        
  86. Mac SPP Theory    Theory of operation of SPP.  Describes an older version of DevLib.
  87.  
  88.  
  89.  
  90. What’s new in this release
  91.  
  92. • The source code for a development library has been included for the first time.  See below.
  93.  
  94. • SPP has been changed to generate tracing statements for exxx routines.  See below.
  95.  
  96. • The RETURN_xxx macros are no longer present, though SPP still can generate them.
  97.  
  98. • The SL_WATCH macro is new.  See the Mac Macros documentation for details.
  99.  
  100.  
  101.  
  102. DevLib
  103.  
  104. The  version of Sherlock includes DevLib: a library of routines including the following:
  105.  
  106. • Replacements for malloc and free that check memory for allocation errors.
  107.  
  108. • Routines that handle lifetime memory allocation.
  109.  
  110. • exxx routines, a  set stream output routines and a type-safe replacements for fprintf(stderr).
  111.  
  112. SPP, SDEL and SDIF now use this library, though parts of SPP use an older library as well.
  113.  
  114. Files, folders and projects
  115.  
  116. This distribution should have complete source code for the SPP, SDEL and SDIF tools, including 
  117. all needed files of DevLib, Metrowerks project files and all resources needed for the Metrowerks 
  118. projects.  Please contact me immediately if you are missing any code or documentation file.
  119.  
  120.  
  121. All .π (PI) files were compiled with Symantec C v7.04.  These projects produce 68K code, and 
  122. may be emulated on a Power PC.  All .µ (MU) files were compiled with Metrowerks C v1.4.  
  123. Unless the project name indicates otherwise, Metrowerks projects produce PowerPC code.
  124.  
  125.  
  126. The Sherlock_DevLib folder contains all machine-independent sources for Sherlock: sl.h, sl2.h, 
  127. sl_dump.c, sl_init.c, sl_macro.c, and sl_util.c.
  128.  
  129.  
  130. The DevLibSrc folder contains the sources for DevLib.  It contains two sub folders,  Mac_DevLib 
  131. and Main_DevLib.
  132.  
  133.  
  134. The Mac_DevLib folder contains files used by the Macintosh version of Sherlock, including the 
  135. file mac_gui.c.  mac_gui.c contains the w_mac_init and w_applEvent routines described in the 
  136. Installation Chapter.
  137.  
  138.  
  139. The Main_DevLib folder contains the sources for DevLIb.  The file LIBlib.c is a template file: each 
  140. application must provide its own customized copy of this file.
  141.